home *** CD-ROM | disk | FTP | other *** search
/ IRIX 6.2 Development Libraries / SGI IRIX 6.2 Development Libraries.iso / dist / complib.idb / usr / share / catman / p_man / cat3 / complib / cggqrf.z / cggqrf
Text File  |  1996-03-14  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. CCCCGGGGGGGGQQQQRRRRFFFF((((3333FFFF))))                                                          CCCCGGGGGGGGQQQQRRRRFFFF((((3333FFFF))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      CGGQRF - compute a generalized QR factorization of an N-by-M matrix A and
  10.      an N-by-P matrix B
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      SUBROUTINE CGGQRF( N, M, P, A, LDA, TAUA, B, LDB, TAUB, WORK, LWORK, INFO
  14.                         )
  15.  
  16.          INTEGER        INFO, LDA, LDB, LWORK, M, N, P
  17.  
  18.          COMPLEX        A( LDA, * ), B( LDB, * ), TAUA( * ), TAUB( * ), WORK(
  19.                         * )
  20.  
  21. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  22.      CGGQRF computes a generalized QR factorization of an N-by-M matrix A and
  23.      an N-by-P matrix B:
  24.  
  25.                  A = Q*R,        B = Q*T*Z,
  26.  
  27.      where Q is an N-by-N unitary matrix, Z is a P-by-P unitary matrix, and R
  28.      and T assume one of the forms:
  29.  
  30.      if N >= M,  R = ( R11 ) M  ,   or if N < M,  R = ( R11  R12 ) N,
  31.                      (  0  ) N-M                         N   M-N
  32.                         M
  33.  
  34.      where R11 is upper triangular, and
  35.  
  36.      if N <= P,  T = ( 0  T12 ) N,   or if N > P,  T = ( T11 ) N-P,
  37.                       P-N  N                           ( T21 ) P
  38.                                                           P
  39.  
  40.      where T12 or T21 is upper triangular.
  41.  
  42.      In particular, if B is square and nonsingular, the GQR factorization of A
  43.      and B implicitly gives the QR factorization of inv(B)*A:
  44.  
  45.                   inv(B)*A = Z'*(inv(T)*R)
  46.  
  47.      where inv(B) denotes the inverse of the matrix B, and Z' denotes the
  48.      conjugate transpose of matrix Z.
  49.  
  50.  
  51. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  52.      N       (input) INTEGER
  53.              The number of rows of the matrices A and B. N >= 0.
  54.  
  55.      M       (input) INTEGER
  56.              The number of columns of the matrix A.  M >= 0.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. CCCCGGGGGGGGQQQQRRRRFFFF((((3333FFFF))))                                                          CCCCGGGGGGGGQQQQRRRRFFFF((((3333FFFF))))
  71.  
  72.  
  73.  
  74.      P       (input) INTEGER
  75.              The number of columns of the matrix B.  P >= 0.
  76.  
  77.      A       (input/output) COMPLEX array, dimension (LDA,M)
  78.              On entry, the N-by-M matrix A.  On exit, the elements on and
  79.              above the diagonal of the array contain the min(N,M)-by-M upper
  80.              trapezoidal matrix R (R is upper triangular if N >= M); the
  81.              elements below the diagonal, with the array TAUA, represent the
  82.              unitary matrix Q as a product of min(N,M) elementary reflectors
  83.              (see Further Details).
  84.  
  85.      LDA     (input) INTEGER
  86.              The leading dimension of the array A. LDA >= max(1,N).
  87.  
  88.      TAUA    (output) COMPLEX array, dimension (min(N,M))
  89.              The scalar factors of the elementary reflectors which represent
  90.              the unitary matrix Q (see Further Details).  B
  91.              (input/output) COMPLEX array, dimension (LDB,P) On entry, the N-
  92.              by-P matrix B.  On exit, if N <= P, the upper triangle of the
  93.              subarray B(1:N,P-N+1:P) contains the N-by-N upper triangular
  94.              matrix T; if N > P, the elements on and above the (N-P)-th
  95.              subdiagonal contain the N-by-P upper trapezoidal matrix T; the
  96.              remaining elements, with the array TAUB, represent the unitary
  97.              matrix Z as a product of elementary reflectors (see Further
  98.              Details).
  99.  
  100.      LDB     (input) INTEGER
  101.              The leading dimension of the array B. LDB >= max(1,N).
  102.  
  103.      TAUB    (output) COMPLEX array, dimension (min(N,P))
  104.              The scalar factors of the elementary reflectors which represent
  105.              the unitary matrix Z (see Further Details).  WORK
  106.              (workspace/output) COMPLEX array, dimension (LWORK) On exit, if
  107.              INFO = 0, WORK(1) returns the optimal LWORK.
  108.  
  109.      LWORK   (input) INTEGER
  110.              The dimension of the array WORK. LWORK >= max(1,N,M,P).  For
  111.              optimum performance LWORK >= max(N,M,P)*max(NB1,NB2,NB3), where
  112.              NB1 is the optimal blocksize for the QR factorization of an N-
  113.              by-M matrix, NB2 is the optimal blocksize for the RQ
  114.              factorization of an N-by-P matrix, and NB3 is the optimal
  115.              blocksize for a call of CUNMQR.
  116.  
  117.      INFO    (output) INTEGER
  118.              = 0:  successful exit
  119.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  120.  
  121. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  122.      The matrix Q is represented as a product of elementary reflectors
  123.  
  124.         Q = H(1) H(2) . . . H(k), where k = min(n,m).
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. CCCCGGGGGGGGQQQQRRRRFFFF((((3333FFFF))))                                                          CCCCGGGGGGGGQQQQRRRRFFFF((((3333FFFF))))
  137.  
  138.  
  139.  
  140.      Each H(i) has the form
  141.  
  142.         H(i) = I - taua * v * v'
  143.  
  144.      where taua is a complex scalar, and v is a complex vector with v(1:i-1) =
  145.      0 and v(i) = 1; v(i+1:n) is stored on exit in A(i+1:n,i), and taua in
  146.      TAUA(i).
  147.      To form Q explicitly, use LAPACK subroutine CUNGQR.
  148.      To use Q to update another matrix, use LAPACK subroutine CUNMQR.
  149.  
  150.      The matrix Z is represented as a product of elementary reflectors
  151.  
  152.         Z = H(1) H(2) . . . H(k), where k = min(n,p).
  153.  
  154.      Each H(i) has the form
  155.  
  156.         H(i) = I - taub * v * v'
  157.  
  158.      where taub is a complex scalar, and v is a complex vector with v(p-
  159.      k+i+1:p) = 0 and v(p-k+i) = 1; v(1:p-k+i-1) is stored on exit in B(n-
  160.      k+i,1:p-k+i-1), and taub in TAUB(i).
  161.      To form Z explicitly, use LAPACK subroutine CUNGRQ.
  162.      To use Z to update another matrix, use LAPACK subroutine CUNMRQ.
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.